<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="xmlrpc-client-example.html" />
<link rel="prev" href="node656.html" />
<link rel="parent" href="module-xmlrpclib.html" />
<link rel="next" href="xmlrpc-client-example.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>18.24.8 Convenience Functions</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.24.7 multicall Objects"
  href="node656.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="18.24 xmlrpclib  "
  href="module-xmlrpclib.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="18.24.9 example of Client"
  href="xmlrpc-client-example.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node656.html">18.24.7 MultiCall Objects</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-xmlrpclib.html">18.24 xmlrpclib  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="xmlrpc-client-example.html">18.24.9 Example of Client</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h2><a name="SECTION00202480000000000000000">
18.24.8 Convenience Functions</a>
</h2>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4461' xml:id='l2h-4461' class="function">boolean</tt></b>(</nobr></td>
  <td><var>value</var>)</td></tr></table></dt>
<dd>
Convert any Python value to one of the XML-RPC Boolean constants,
<code>True</code> or <code>False</code>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4462' xml:id='l2h-4462' class="function">dumps</tt></b>(</nobr></td>
  <td><var>params</var><big>[</big><var>, methodname</var><big>[</big><var>, 
	                methodresponse</var><big>[</big><var>, encoding</var><big>[</big><var>,
	                allow_none</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Convert <var>params</var> into an XML-RPC request.
or into a response if <var>methodresponse</var> is true.
<var>params</var> can be either a tuple of arguments or an instance of the 
<tt class="exception">Fault</tt> exception class.  If <var>methodresponse</var> is true,
only a single value can be returned, meaning that <var>params</var> must be of length 1.
<var>encoding</var>, if supplied, is the encoding to use in the generated
XML; the default is UTF-8.  Python's <tt class="constant">None</tt> value cannot be
used in standard XML-RPC; to allow using it via an extension, 
provide a true value for <var>allow_none</var>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4463' xml:id='l2h-4463' class="function">loads</tt></b>(</nobr></td>
  <td><var>data</var><big>[</big><var>, use_datetime</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Convert an XML-RPC request or response into Python objects, a
<code>(<var>params</var>, <var>methodname</var>)</code>.  <var>params</var> is a tuple of argument; <var>methodname</var>
is a string, or <code>None</code> if no method name is present in the packet.
If the XML-RPC packet represents a fault condition, this
function will raise a <tt class="exception">Fault</tt> exception.
The <var>use_datetime</var> flag can be used to cause date/time values to be
presented as <tt class="class"><tt class="module"><a href="module-datetime.html">datetime</a></tt>.datetime</tt> objects; this is false
by default.
Note that even if you call an XML-RPC method with
<tt class="class"><tt class="module"><a href="module-datetime.html">datetime</a></tt>.date</tt> or <tt class="class"><tt class="module"><a href="module-datetime.html">datetime</a></tt>.time</tt>
objects, they are converted to <tt class="class">DateTime</tt> objects internally, so only
<tt class="class"><tt class="module"><a href="module-datetime.html">datetime</a></tt>.datetime</tt> objects will be returned.

<p>

<span class="versionnote">Changed in version 2.5:
The <var>use_datetime</var> flag was added.</span>

</dl>

<p>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.24.7 multicall Objects"
  href="node656.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="18.24 xmlrpclib  "
  href="module-xmlrpclib.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="18.24.9 example of Client"
  href="xmlrpc-client-example.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node656.html">18.24.7 MultiCall Objects</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-xmlrpclib.html">18.24 xmlrpclib  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="xmlrpc-client-example.html">18.24.9 Example of Client</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
